This is a template project which uses the Spectacles Spatial Anchor API.
NOTE: This project will only work for the Spectacles platform.
Designing Lenses for Spectacles offers all-new possibilities to rethink user interaction with digital spaces and the physical world. Get started using our Design Guidelines
- Lens Studio: v5.15.0+
- Spectacles OS Version: v5.64+
- Spectacles App iOS: v0.64+
- Spectacles App Android: v0.64+
To update your Spectacles device and mobile app, refer to this guide.
You can download the latest version of Lens Studio from here.
To obtain the project folder, you need to clone the repository.
IMPORTANT: This project uses Git Large Files Support (LFS). Downloading a zip file using the green button on Github will not work. You must clone the project with a version of git that has LFS. You can download Git LFS here: https://git-lfs.github.com/.
The project should be pre-configured to get you started without any additional steps. However, if you encounter issues in the Logger Panel, please ensure your Lens Studio environment is set up for Spectacles.
AreaManager.ts - This is the primary script that integrates different behaviours with the UI. AnchorManager.ts - Primary script for managing the anchor behaviours TextInputManager - Primary script for handling keyboard input
In the Interactive Preview Panel. Click on the New Area button in the area selection menu with the left mouse button. A panel will then show up where user can drag different post-it notes to the scene. Click on the Main Menu to go back to the area selection menu.
To install your Lens on your device, refer to the guide provided here.
After successfully installing the Lens, Select the New Area button with the pinch gesture. The localization process should begin with a prompt text appeared informing the user to look around. After the localization completes, a panel will then show up where user can drag different post-it notes to the scene. Click on the Main Menu to go back to the area selection menu.
Exit the lens and open it again. If the same area is selected, the previously created notes will spawn in the same position in the space.
When it fails to locate the previously mapped area, the recovery mode will be activated. The lens will restore the post-it notes in front of the user with the same relative positions. The user will be able to adjust the anchor point of the notes and press the save button to update the mapping.
After a post-it note is created, select the edit button on the top left corner to launch the AR keyboard.
If you have any questions or need assistance, please don't hesitate to reach out. Our community is here to help, and you can connect with us and ask for support here. We look forward to hearing from you and are excited to assist you on your journey!
Feel free to provide improvements or suggestions or directly contributing via merge request. By sharing insights, you help everyone else build better Lenses.
Built with 👻 by the Spectacles team